Skip to content

Closes: #18588: Relabel Service to Application Service #19900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: feature
Choose a base branch
from

Conversation

jnovinger
Copy link
Member

@jnovinger jnovinger commented Jul 16, 2025

Closes: #18588

This PR relabels the Service model to "Application Service" (and ServiceTemplate to "Application Service Template") throughout the UI to make it clearer what this model is actually for.

"Application Service" was chosen because it best describes the model's intent: to represent pretty much anything running above the transport layer (L4). This includes classic examples like SSH, HTTPS, and NTP, but also custom applications, APIs, or any other process defined by a protocol and port. The name "L7 Service" was considered, but it felt a little too restrictive and could be confusing for users who also interact with programmatic aspects of NetBox.

To ensure backward compatibility, this is a UI-only change. The underlying models, REST API endpoints, and GraphQL schema remain unchanged.
TODO:

  • Update Service and ServiceTemplate verbose_name and adapt test suites (django-filter, GraphQL) to assert API stability.
  • Rename Service and Service template in the IPAM sub-menu.
  • Update hardcoded labels for buttons, titles, and messages across all relevant templates, views, forms, and tables.
  • Update docs as necessary.
  • Optional: work to make sure translations exist This should be covered by routine Transifex maintenance.

Updates the `verbose_name` of the `Service` and `ServiceTemplate` models to "Application Service" and
"Application Service Template" respectively. This serves as the foundational change for relabeling
the model throughout the user interface to reduce ambiguity.

To preserve backward compatibility for the REST and GraphQL APIs, the test suites have been updated
to assert the stability of the original field and parameter names. This includes:

*   Using `filter_name_map` in the filterset test case to ensure API query parameters remain
    `service` and `service_id`.
*   Employing the GraphQL test suite's aliasing mechanism to ensure the public schema remains
    unchanged despite the underlying `verbose_name` modification.

Subsequent commits will address UI-specific labels in navigation, tables, forms, and templates.
@jnovinger jnovinger marked this pull request as draft July 16, 2025 19:06
@jnovinger jnovinger marked this pull request as ready for review July 18, 2025 14:39
@jnovinger jnovinger requested review from a team and jeremystretch and removed request for a team July 18, 2025 14:39
@jnovinger jnovinger marked this pull request as draft July 18, 2025 14:43
@jnovinger jnovinger marked this pull request as ready for review July 18, 2025 16:55
@@ -1,6 +1,6 @@
## Interfaces

[Virtual machine](./virtualmachine.md) interfaces behave similarly to device [interfaces](../dcim/interface.md): They can be assigned to VRFs, may have IP addresses, VLANs, and services attached to them, and so on. However, given their virtual nature, they lack properties pertaining to physical attributes. For example, VM interfaces do not have a physical type and cannot have cables attached to them.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed this bit here because I could not find any direct relationship between application services and VM interfaces. If this is some other concept of service, let me know and I can add it back.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant